Summary

Fully Qualified Name:

CodeIgniter\Database\ResultInterface

Description

Methods

Name	Description	Defined By
dataSeek()	Moves the internal pointer to the desired offset. This is called internally before fetching results to make sure the result set starts at zero.	ResultInterface
freeResult()	Frees the current result.	ResultInterface
getCustomResultObject()	Returns the results as an array of custom objects.	ResultInterface
getCustomRowObject()	Returns a row as a custom class instance.	ResultInterface
getFieldCount()	Gets the number of fields in the result set.	ResultInterface
getFieldData()	Generates an array of objects representing field meta-data.	ResultInterface
getFieldNames()	Generates an array of column names in the result set.	ResultInterface
getFirstRow()	Returns the "first" row of the current results.	ResultInterface
getLastRow()	Returns the "last" row of the current results.	ResultInterface
getNextRow()	Returns the "next" row of the current results.	ResultInterface
getPreviousRow()	Returns the "previous" row of the current results.	ResultInterface
getResult()	Retrieve the results of the query. Typically an array of individual data rows, which can be either an 'array', an 'object', or a custom class name.	ResultInterface
getResultArray()	Returns the results as an array of arrays.	ResultInterface
getResultObject()	Returns the results as an array of objects.	ResultInterface
getRow()	Wrapper object to return a row as either an array, an object, or a custom class.	ResultInterface
getRowArray()	Returns a single row from the results as an array.	ResultInterface
getRowObject()	Returns a single row from the results as an object.	ResultInterface
getUnbufferedRow()	Returns an unbuffered row and move the pointer to the next row.	ResultInterface
setRow()	Assigns an item into a particular column slot.	ResultInterface

Method Details

dataSeek()

Moves the internal pointer to the desired offset. This is called internally before fetching results to make sure the result set starts at zero.

Parameter Name	Type	Description
$n	int

Returns: mixed

freeResult()

Frees the current result.

Returns: void

getCustomResultObject()

Returns the results as an array of custom objects.

Parameter Name	Type	Description
$className	string	The

Returns: mixed

getCustomRowObject()

Returns a row as a custom class instance.

If row doesn't exists, returns null.

Parameter Name	Type	Description
$n	int
$className	string

Returns: mixed

getFieldCount()

Gets the number of fields in the result set.

Returns: int

getFieldData()

Generates an array of objects representing field meta-data.

Returns: array

getFieldNames()

Generates an array of column names in the result set.

Returns: array

getFirstRow()

Returns the "first" row of the current results.

Parameter Name	Type	Description
$type	string

Returns: mixed

getLastRow()

Returns the "last" row of the current results.

Parameter Name	Type	Description
$type	string

Returns: mixed

getNextRow()

Returns the "next" row of the current results.

Parameter Name	Type	Description
$type	string

Returns: mixed

getPreviousRow()

Returns the "previous" row of the current results.

Parameter Name	Type	Description
$type	string

Returns: mixed

getResult()

Retrieve the results of the query. Typically an array of individual data rows, which can be either an 'array', an 'object', or a custom class name.

Parameter Name	Type	Description
$type	string	The

Returns: mixed

getResultArray()

Returns the results as an array of arrays.

If no results, an empty array is returned.

Returns: array

getResultObject()

Returns the results as an array of objects.

If no results, an empty array is returned.

Returns: array

getRow()

Wrapper object to return a row as either an array, an object, or a custom class.

If row doesn't exist, returns null.

Parameter Name	Type	Description
$n	mixed	The
$type	string	The

Returns: mixed

getRowArray()

Returns a single row from the results as an array.

If row doesn't exist, returns null.

Parameter Name	Type	Description
$n	int

Returns: mixed

getRowObject()

Returns a single row from the results as an object.

If row doesn't exist, returns null.

Parameter Name	Type	Description
$n	int

Returns: mixed

getUnbufferedRow()

Returns an unbuffered row and move the pointer to the next row.

Parameter Name	Type	Description
$type	string

Returns: mixed

setRow()

Assigns an item into a particular column slot.

Parameter Name	Type	Description
	$key
$value	null
$key

Returns: mixed